Installation Notes

Note: Axiell Staff: Before proceeding with any upgrade, please complete the System Upgrade Checklist form. This can be found on the Axiell Staff website: Business Procedures>Forms & Templates.

IMPORTANT!

If you are installing Sapphire in an environment alongside EMu 9.0 or later, DO NOT use these installation notes.

From EMu 9.0 onwards, Sapphire is bundled with EMu and the installation notes on the EMu Support site must be used.

formerly 1.5.2

Sapphire is designed to allow multiple installations to coexist. Each installation is placed in a directory and the name of this directory typically reflects the version of Sapphire being installed:

  1. Login as user root
  2. Install Apache:

    Linux

    yum install httpd

    FreeBSD

    pkg install apache24

  1. Login as user root
  2. Install PHP and DOM extensions:

    Linux

    yum install php

    yum install php-xml

    FreeBSD

    pkg install php80

    pkg install php80-xml

Sapphire can be installed as any user. The following covers an installation for user imu:

  1. Login as user imu
  2. Install Sapphire:

    mkdir sapphire

    cd sapphire

    mkdir sapphire-1.5.2

    tar xzf sapphire-1.5.2.tgz sapphire-1.5.2

    ln -s sapphire-1.5.2 latest

  3. Modify the sapphire index.html file for improved response times:

    cd sapphire-1.5.2

    vim index.html

  4. Find the following line:

    <script type=”text/javascript” src=”imu/imu.php”></script>

    and change php to js:

    <script type=”text/javascript” src=”imu/imu.js”></script>

  5. Save the file.
  6. Configure Sapphire to connect to the EMu server:

    cd imu/config

    vim local.php

  7. Add the following lines:

    <?php

    $config[“server-host”] = “emu.server.address”;

    $config[“server-port”] = port;

    ?>

    where emu.server.address is the name or IP address of the EMu server and port is the normal EMu server port number plus 20000, e.g. if the normal EMu port number is 20001, the Sapphire port is 40001.

  8. Save the file.
  9. Configure local date formats if necessary. The default setting is to use the local date format. More information on the formats used for dates can be found at https://momentjs.com/docs/#/parsing/string-format/

    vim local.js

    The following lines reflect the default settings. If different date settings are to be used, add the following two lines, adjust the format setting and save the file.

    IMu.Config.defaultDateFormat = “L”;

    IMu.Config.serverDateFormat = “YYYY/MM/DD”;

  10. Prepare Sapphire for use:

    cd ..

    php imu.php

  1. Login as user root
  2. Locate and navigate to the Apache config directory (typically located here: /etc/httpd/):

    cd /etc/httpd/

  3. Allow Apache to find Sapphire.

    There are two ways this can be done:

    Either:

    1. Create a new VirtualHost config file:

      vim conf.d/sapphire.conf

    2. Configure a VirtualHost for Sapphire if desired.

      This example is for installations performed as user imu (see above).

      Note: Any installation that provides external access (outside the Intranet) should be configured to use HTTPS. In this case, change:
      <VirtualHost *:80>
      to
      <VirtualHost *:443>

      <VirtualHost *:80>

      DocumentRoot /home/imu/sapphire/latest

      <Directory “/home/imu/sapphire/latest”>

      Options FollowSymLinks

      AllowOverride All

      Order allow,deny

      Allow from all

      </Directory>

      </VirtualHost>

    3. Save the file.

    Or

    1. Change directory to the DocumentRoot:

      This directory is typically /var/www/html and set sapphire to where Sapphire is installed:

      cd /var/www/html

      ln -s /home/imu/sapphire/latest sapphire

  4. Restart Apache:

    service httpd graceful

  5. On Linux systems with SELinux enabled, enable HTTPD by running:

    semanage permissive –a httpd_t

  1. Login as root
  2. Locate and navigate to the Apache config directory (typically located here: /usr/local/etc/apache24/):

    cd /usr/local/etc/apache24

  3. Allow Apache to find Sapphire. There are two ways this can be done.

    Either:

    1. Add a new VirtualHost to the config file:

      vim httpd.conf

    2. Configure a VirtualHost for Sapphire if desired.

      This example is for installations performed as user imu (see above).

      Note: Any installation that provides external access (outside the Intranet) should be configured to use HTTPS. In this case, change:
      <VirtualHost *:80>
      to
      <VirtualHost *:443>

      <VirtualHost *:80>

      DocumentRoot /home/imu/sapphire/latest

      <Directory “/home/imu/sapphire/latest”>

      Options FollowSymLinks

      AllowOverride All

      Order allow,deny

      Allow from all

      </Directory>

      </VirtualHost>

    3. Save the file.

    Or:

    1. Change directory to the DocumentRoot (typically /usr/local/www/apache24/data) and set sapphire to where Sapphire is installed:

      cd /usr/local/www/apache24/data

      ln -s /home/imu/sapphire/latest sapphire

  4. Restart Apache:

    apachectl restart

Sapphire is designed to allow multiple installations to coexist. Each installation is placed in a directory and the name of this directory typically reflects the version of Sapphire being installed:

  1. Login as user root
  2. Install Apache:

    Linux

    yum install httpd

    FreeBSD

    pkg install apache24

  1. Login as user root
  2. Install PHP and DOM extensions:

    Linux

    yum install php

    yum install php-xml

    FreeBSD

    pkg install php80

    pkg install php80-xml

Sapphire can be installed as any user. The following covers an installation for user imu:

  1. Login as user imu
  2. Install Sapphire:

    mkdir sapphire

    cd sapphire

    mkdir sapphire-1.5.1

    tar xzf sapphire-1.5.1.tgz sapphire-1.5.1

    ln -s sapphire-1.5.1 latest

  3. Modify the sapphire index.html file for improved response times:

    cd sapphire-1.5.1

    vim index.html

  4. Find the following line:

    <script type=”text/javascript” src=”imu/imu.php”></script>

    and change php to js:

    <script type=”text/javascript” src=”imu/imu.js”></script>

  5. Save the file.
  6. Configure Sapphire to connect to the EMu server:

    cd imu/config

    vim local.php

  7. Add the following lines:

    <?php

    $config[“server-host”] = “emu.server.address”;

    $config[“server-port”] = port;

    ?>

    where emu.server.address is the name or IP address of the EMu server and port is the normal EMu server port number plus 20000, e.g. if the normal EMu port number is 20001, the Sapphire port is 40001.

  8. Save the file.
  9. Configure local date formats if necessary. The default setting is to use the local date format. More information on the formats used for dates can be found at https://momentjs.com/docs/#/parsing/string-format/

    vim local.js

    The following lines reflect the default settings. If different date settings are to be used, add the following two lines, adjust the format setting and save the file.

    IMu.Config.defaultDateFormat = “L”;

    IMu.Config.serverDateFormat = “YYYY/MM/DD”;

  10. Prepare Sapphire for use:

    cd ..

    php imu.php

  1. Login as user root
  2. Locate and navigate to the Apache config directory (typically located here: /etc/httpd/):

    cd /etc/httpd/

  3. Allow Apache to find Sapphire.

    There are two ways this can be done:

    Either:

    1. Create a new VirtualHost config file:

      vim conf.d/sapphire.conf

    2. Configure a VirtualHost for Sapphire if desired.

      This example is for installations performed as user imu (see above).

      Note: Any installation that provides external access (outside the Intranet) should be configured to use HTTPS. In this case, change:
      <VirtualHost *:80>
      to
      <VirtualHost *:443>

      <VirtualHost *:80>

      DocumentRoot /home/imu/sapphire/latest

      <Directory “/home/imu/sapphire/latest”>

      Options FollowSymLinks

      AllowOverride All

      Order allow,deny

      Allow from all

      </Directory>

      </VirtualHost>

    3. Save the file.

    Or

    1. Change directory to the DocumentRoot:

      This directory is typically /var/www/html and set sapphire to where Sapphire is installed:

      cd /var/www/html

      ln -s /home/imu/sapphire/latest sapphire

  4. Restart Apache:

    service httpd graceful

  5. On Linux systems with SELinux enabled, enable HTTPD by running:

    semanage permissive –a httpd_t

  1. Login as root
  2. Locate and navigate to the Apache config directory (typically located here: /usr/local/etc/apache24/):

    cd /usr/local/etc/apache24

  3. Allow Apache to find Sapphire. There are two ways this can be done.

    Either:

    1. Add a new VirtualHost to the config file:

      vim httpd.conf

    2. Configure a VirtualHost for Sapphire if desired.

      This example is for installations performed as user imu (see above).

      Note: Any installation that provides external access (outside the Intranet) should be configured to use HTTPS. In this case, change:
      <VirtualHost *:80>
      to
      <VirtualHost *:443>

      <VirtualHost *:80>

      DocumentRoot /home/imu/sapphire/latest

      <Directory “/home/imu/sapphire/latest”>

      Options FollowSymLinks

      AllowOverride All

      Order allow,deny

      Allow from all

      </Directory>

      </VirtualHost>

    3. Save the file.

    Or:

    1. Change directory to the DocumentRoot (typically /usr/local/www/apache24/data) and set sapphire to where Sapphire is installed:

      cd /usr/local/www/apache24/data

      ln -s /home/imu/sapphire/latest sapphire

  4. Restart Apache:

    apachectl restart